Skip to content

Add pytest-check-links for internal URLs #3677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

Add pytest-check-links for internal URLs #3677

wants to merge 7 commits into from

Conversation

bollwyvl
Copy link
Contributor

References

Changes

  • adds pytest-check-links
  • adds docs about running locally
  • adds to docs CI

Future work

  • checking external links is a bit more fiddly, and benefits from a more precise use of caching to avoid making way too many requests and getting rate-banned

@bollwyvl
Copy link
Contributor Author

Note this is still failing the binder badge, as I guess it uses the one from main?

@bollwyvl
Copy link
Contributor Author

Whew, the generated pages are: a) really slow and b) do have a lot of errors.

I'm not sure how to gate this properly to make it effective in CI: waiting for a merge to main seems too late, while blocking every PR seems worse.

I guess it could be split into multiple jobs:

  • one for typedoc
  • one for autodoc
  • one for "the rest"

@bollwyvl
Copy link
Contributor Author

I don't think it's gonna finish 😿

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@bollwyvl